<meta charset="utf-8">
(#) The ui-test-manifest library should be included using the debugImplementation configuration

!!! WARNING: The ui-test-manifest library should be included using the debugImplementation configuration
   This is a warning.

Id
:   `TestManifestGradleConfiguration`
Summary
:   The ui-test-manifest library should be included using the debugImplementation configuration
Severity
:   Warning
Category
:   Correctness
Platform
:   Android
Vendor
:   Android Open Source Project
Identifier
:   androidx.compose.ui.test.manifest
Feedback
:   https://issuetracker.google.com/issues/new?component=741505
Min
:   Lint 8.0 and 8.1
Compiled
:   Lint 8.7+
Artifact
:   [androidx.compose.ui:ui-test-manifest](androidx_compose_ui_ui-test-manifest.md.html)
Since
:   1.2.0
Affects
:   Gradle build files
Editing
:   This check runs on the fly in the IDE editor
See
:   https://developer.android.com/jetpack/compose/testing#setup
Implementation
:   [Source Code](https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:/compose/ui/ui-test-manifest-lint/src/main/java/androidx/compose/ui/test/manifest/lint/GradleDebugConfigurationDetector.kt)
Tests
:   [Source Code](https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:/compose/ui/ui-test-manifest-lint/src/test/java/androix/compose/ui/test/manifest/lint/GradleDebugConfigurationDetectorTest.kt)
Copyright Year
:   2022

The androidx.compose.ui:ui-test-manifest dependency is needed for
launching a Compose host, such as with createComposeRule. However, it
only needs to be present in testing configurations therefore use this
dependency with the debugImplementation configuration.

(##) Example

Here is an example of lint warnings produced by this check:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~text
build.gradle:2:Warning: Please use debugImplementation.
[TestManifestGradleConfiguration]
    implementation("androidx.compose.ui:ui-test-manifest:1.2.0-beta02")
    -------------------------------------------------------------------
build.gradle:3:Warning: Please use debugImplementation.
[TestManifestGradleConfiguration]
    api("androidx.compose.ui:ui-test-manifest:1.2.0-beta02")
    --------------------------------------------------------
build.gradle:4:Warning: Please use debugImplementation.
[TestManifestGradleConfiguration]
    compileOnly("androidx.compose.ui:ui-test-manifest:1.2.0-beta02")
    ----------------------------------------------------------------
build.gradle:5:Warning: Please use debugImplementation.
[TestManifestGradleConfiguration]
    runtimeOnly("androidx.compose.ui:ui-test-manifest:1.2.0-beta02")
    ----------------------------------------------------------------
build.gradle:6:Warning: Please use debugImplementation.
[TestManifestGradleConfiguration]
    annotationProcessor("androidx.compose.ui:ui-test-manifest:1.2.0-beta02")
    ------------------------------------------------------------------------
build.gradle:7:Warning: Please use debugImplementation.
[TestManifestGradleConfiguration]
    lintChecks("androidx.compose.ui:ui-test-manifest:1.2.0-beta02")
    ---------------------------------------------------------------
build.gradle:8:Warning: Please use debugImplementation.
[TestManifestGradleConfiguration]
    lintPublish("androidx.compose.ui:ui-test-manifest:1.2.0-beta02")
    ----------------------------------------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Here is the source file referenced above:

`build.gradle`:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~groovy linenumbers
dependencies {
    implementation("androidx.compose.ui:ui-test-manifest:1.2.0-beta02")
    api("androidx.compose.ui:ui-test-manifest:1.2.0-beta02")
    compileOnly("androidx.compose.ui:ui-test-manifest:1.2.0-beta02")
    runtimeOnly("androidx.compose.ui:ui-test-manifest:1.2.0-beta02")
    annotationProcessor("androidx.compose.ui:ui-test-manifest:1.2.0-beta02")
    lintChecks("androidx.compose.ui:ui-test-manifest:1.2.0-beta02")
    lintPublish("androidx.compose.ui:ui-test-manifest:1.2.0-beta02")
}
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can also visit the
[source code](https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:/compose/ui/ui-test-manifest-lint/src/test/java/androix/compose/ui/test/manifest/lint/GradleDebugConfigurationDetectorTest.kt)
for the unit tests for this check to see additional scenarios.

The above example was automatically extracted from the first unit test
found for this lint check, `GradleDebugConfigurationDetector.kotlin_manifestDependencyInBlockedConfigs_shouldRaiseIssue`.
To report a problem with this extracted sample, visit
https://issuetracker.google.com/issues/new?component=741505.

(##) Including

!!!
   This is not a built-in check. To include it, add the below dependency
   to your project.

```
// build.gradle.kts
implementation("androidx.compose.ui:ui-test-manifest:1.8.0-alpha07")

// build.gradle
implementation 'androidx.compose.ui:ui-test-manifest:1.8.0-alpha07'

// build.gradle.kts with version catalogs:
implementation(libs.ui.test.manifest)

# libs.versions.toml
[versions]
ui-test-manifest = "1.8.0-alpha07"
[libraries]
# For clarity and text wrapping purposes the following declaration is
# shown split up across lines, but in TOML it needs to be on a single
# line (see https://github.com/toml-lang/toml/issues/516) so adjust
# when pasting into libs.versions.toml:
ui-test-manifest = {
    module = "androidx.compose.ui:ui-test-manifest",
    version.ref = "ui-test-manifest"
}
```

1.8.0-alpha07 is the version this documentation was generated from;
there may be newer versions available.

NOTE: These lint checks are **also** made available separate from the main library.
You can also use `androidx.compose.ui:ui-test-manifest-lint:1.8.0-alpha07`.


[Additional details about androidx.compose.ui:ui-test-manifest](androidx_compose_ui_ui-test-manifest.md.html).
(##) Suppressing

You can suppress false positives using one of the following mechanisms:

* Using a suppression comment like this on the line above:

  ```kt
  //noinspection TestManifestGradleConfiguration
  problematicStatement()
  ```

* Using a special `lint.xml` file in the source tree which turns off
  the check in that folder and any sub folder. A simple file might look
  like this:
  ```xml
  &lt;?xml version="1.0" encoding="UTF-8"?&gt;
  &lt;lint&gt;
      &lt;issue id="TestManifestGradleConfiguration" severity="ignore" /&gt;
  &lt;/lint&gt;
  ```
  Instead of `ignore` you can also change the severity here, for
  example from `error` to `warning`. You can find additional
  documentation on how to filter issues by path, regular expression and
  so on
  [here](https://googlesamples.github.io/android-custom-lint-rules/usage/lintxml.md.html).

* In Gradle projects, using the DSL syntax to configure lint. For
  example, you can use something like
  ```gradle
  lintOptions {
      disable 'TestManifestGradleConfiguration'
  }
  ```
  In Android projects this should be nested inside an `android { }`
  block.

* For manual invocations of `lint`, using the `--ignore` flag:
  ```
  $ lint --ignore TestManifestGradleConfiguration ...`
  ```

* Last, but not least, using baselines, as discussed
  [here](https://googlesamples.github.io/android-custom-lint-rules/usage/baselines.md.html).

<!-- Markdeep: --><style class="fallback">body{visibility:hidden;white-space:pre;font-family:monospace}</style><script src="markdeep.min.js" charset="utf-8"></script><script src="https://morgan3d.github.io/markdeep/latest/markdeep.min.js" charset="utf-8"></script><script>window.alreadyProcessedMarkdeep||(document.body.style.visibility="visible")</script>